eslint-plugin-node

What is eslint-plugin-node?

The eslint-plugin-node package is an ESLint plugin that contains rules that are specific to Node.js development. It helps in identifying issues related to syntax and patterns that are not optimal or could lead to errors in a Node.js context.

What are eslint-plugin-node's main functionalities?

Process Exit As Throw

This rule treats calls to process.exit() as throw statements, which can be useful for highlighting an unexpected termination of the Node.js process.

/* eslint node/no-process-exit: 'error' */
process.exit(1);

No Deprecated API

This rule prevents the use of deprecated Node.js APIs to encourage best practices and avoid potential future issues with deprecated methods.

/* eslint node/no-deprecated-api: 'error' */
const domain = require('domain');

No Missing Imports

This rule ensures that all modules that are imported into a file are actually resolvable, helping to catch typos and incorrect module names.

/* eslint node/no-missing-import: 'error' */
import someModule from 'nonexistent-module';

No Unpublished Bin

This rule checks that all files referenced in the 'bin' field of package.json are actually published, preventing issues with npm packages.

/* eslint node/no-unpublished-bin: 'error' */
{
  "bin": "bin/nonexistent.js"
}

Other packages similar to eslint-plugin-node

eslint-plugin-import

This package provides similar functionality to eslint-plugin-node in terms of managing imports and exports in your code. It includes features like ensuring imports point to a file/module that can be resolved.

eslint-plugin-promise

While eslint-plugin-node focuses on Node.js-specific rules, eslint-plugin-promise provides rules that are specific to the use of promises in JavaScript, which can be relevant in Node.js for handling asynchronous operations.

eslint-plugin-security

This package focuses on identifying potential security issues in Node.js code, which complements eslint-plugin-node's focus on Node.js best practices and avoiding deprecated or problematic patterns.

README

eslint-plugin-node

Additional ESLint's rules for Node.js

💿 Install & Usage

$ npm install --save-dev eslint eslint-plugin-node

• Requires Node.js ^4.0.0 || >=6.0.0
• Requires ESLint >=3.1.0

Note: It recommends a use of the "engines" field of package.json. The "engines" field is used by no-unsupported-features rule.

.eslintrc.json (An example)

{
    "plugins": ["node"],
    "extends": ["eslint:recommended", "plugin:node/recommended"],
    "rules": {
        "node/exports-style": ["error", "module.exports"],
    }
}

package.json (An example)

{
    "name": "your-module",
    "version": "1.0.0",
    "engines": {
        "node": ">=4.0.0"
    }
}

📖 Rules

• ⭐️ - the mark of recommended rules.
• ✒️ - the mark of fixable rules.

Possible Errors

	Rule ID	Description
	no-extraneous-import	disallow import declarations of extraneous packages
⭐️	no-extraneous-require	disallow require() expressions of extraneous packages
	no-missing-import	disallow import declarations of missing files
⭐️	no-missing-require	disallow require() expressions of missing files
⭐️	no-unpublished-bin	disallow 'bin' files which are ignored by npm
	no-unpublished-import	disallow import declarations of private things
⭐️	no-unpublished-require	disallow require() expressions of private things
⭐️	no-unsupported-features	disallow unsupported ECMAScript features on the specified version
⭐️	process-exit-as-throw	make process.exit() expressions the same code path as throw
⭐️✒️	shebang	enforce the correct usage of shebang

Best Practices

	Rule ID	Description
⭐️	no-deprecated-api	disallow deprecated APIs

Stylistic Issues

	Rule ID	Description
	exports-style	enforce either module.exports or exports

🔧 Configs

This plugin provides plugin:node/recommended preset config. This preset config:

• enables the environment of ES2015 (ES6) and Node.js.
• enables rules which are given :star: in the above table.
• enables no-process-exit rule because the official document does not recommend a use of process.exit().
• adds {ecmaVersion: 8} into parserOptions.

👫 FAQ

• Q: The no-missing-import / no-missing-require rules don't work with nested folders in SublimeLinter-eslint
• A: See context.getFilename() in rule returns relative path in the SublimeLinter-eslint FAQ.

🚥 Semantic Versioning Policy

eslint-plugin-node follows semantic versioning and ESLint's Semantic Versioning Policy.

• Patch release (intended to not break your lint build)
  • A bug fix in a rule that results in it reporting fewer errors.
  • Improvements to documentation.
  • Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage.
  • Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone).
• Minor release (might break your lint build)
  • A bug fix in a rule that results in it reporting more errors.
  • A new rule is created.
  • A new option to an existing rule is created.
  • An existing rule is deprecated.
• Major release (likely to break your lint build)
  • A support for old Node version is dropped.
  • A support for old ESLint version is dropped.
  • An existing rule is changed in it reporting more errors.
  • An existing rule is removed.
  • An existing option of a rule is removed.
  • An existing config is updated.

📰 Changelog

• GitHub Releases

💎 Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

• npm test runs tests and measures coverage.
• npm run coverage shows the coverage result of npm test command.
• npm run clean removes the coverage result of npm test command.